znp_interface.h

Go to the documentation of this file.

#ifndef ZNP_INTERFACE_H
#define ZNP_INTERFACE_H

#include "../ZNP/znp_commands.h"

//Miscellaneous
unsigned char* znpInit();
unsigned char* znpReset();
char* getResetReason(unsigned char reason);
unsigned char* getVersion();
unsigned int getRandom();
signed int waitForMessage(unsigned int messageType, unsigned int timeoutMs, unsigned int intervalMs);

//ZNP Configuration
void setZigbeeDeviceType(unsigned char deviceType);
void setPanId(unsigned int panId);
void setChannel(unsigned long channelMask);
void setStartupOptions(unsigned char option);
void setCallbacks(unsigned char cb);
void setSecurityMode(unsigned char securityMode);
void setSecurityKey(unsigned char* key);
unsigned char* getConfigurationParameter(unsigned char configId);
void getNetworkConfigurationParameters();

//Device Information Properties
unsigned char* getDeviceInformationProperty(unsigned char dip);
unsigned char* getMacAddress();
unsigned char getDeviceState();
char* getDeviceStateName(unsigned char state);
void getDeviceInformation();

//NV Memory Items
unsigned char getNvItemSize(unsigned char nvItem);
void writeNvItem(unsigned char nvItem, unsigned char* data);
unsigned char* readNvItem(unsigned char nvItem);

//GPIO pin control
unsigned char sysGpio(unsigned char operation, unsigned char value);


//LOGICAL TYPES 
#define COORDINATOR                     0x00
#define ROUTER                          0x01
#define END_DEVICE                      0x02

//Radio Device Information Property 
#define DIP_STATE                       0x00
#define DIP_MAC_ADDRESS                 0x01
#define DIP_SHORT_ADDRESS               0x02
#define DIP_PARENT_SHORT_ADDRESS        0x03
#define DIP_PARENT_MAC_ADDRESS          0x04
#define DIP_CHANNEL                     0x05
#define DIP_PANID                       0x06
#define DIP_EXTENDED_PANID              0x07
#define MAX_DEVICE_INFORMATION_PROPERTY 0x07

#define DIP_MAC_ADDRESS_LENGTH          8
#define DIP_SHORT_ADDRESS_LENGTH        2
#define DIP_PARENT_SHORT_ADDRESS_LENGTH 2
#define DIP_PARENT_MAC_ADDRESS_LENGTH   8
#define DIP_CHANNEL_LENGTH              1
#define DIP_PANID_LENGTH                2
#define DIP_EXTENDED_PANID_LENGTH       8

//WRITE CONFIGURATION OPTIONS 
#define ZCD_NV_STARTUP_OPTION           0x03
#define ZCD_NV_LOGICAL_TYPE             0x87
#define ZCD_NV_ZDO_DIRECT_CB            0x8F
//For Security:
#define ZCD_NV_PRECFGKEY                0x62
#define ZCD_NV_PRECFGKEY_LEN            16
#define ZCD_NV_PRECFGKEYS_ENABLE        0x63
#define ZCD_NV_PRECFGKEYS_ENABLE_LEN    1
#define ZCD_NV_SECURITY_MODE            0x64
#define ZCD_NV_SECURITY_MODE_LEN        1

//NETWORK SPECIFIC CONFIGURATION PARAMETERS 
#define ZCD_NV_PANID                    0x83
#define ZCD_NV_PANID_LEN                2
#define ZCD_NV_CHANLIST                 0x84
#define ZCD_NV_CHANLIST_LEN             4

//STARTUP OPTIONS 
#define STARTOPT_CLEAR_CONFIG           0x01
#define STARTOPT_CLEAR_STATE            0x02
#define STARTOPT_AUTO                   0x04

//used in ZB_SEND_DATA_REQUEST & AF_DATA_REQUEST
#define MAC_ACK                         0x00    //Require Acknowledgement from next device on route
#define AF_APS_ACK                      0x10    //Require Acknowledgement from final destination (if using AFZDO)
#define SAPI_APS_ACK                    0x01    //Require Acknowledgement from final destination (if using Simple API)
#define DEFAULT_RADIUS                  0x0F    //Maximum number of hops to get to destination
#define MAXIMUM_PAYLOAD_LENGTH          66      //84 bytes without security, 66 bytes with security
#define ALL_DEVICES                     0xFFFF
#define ALL_ROUTERS_AND_COORDINATORS    0xFFFC

//Security Options
#define SECURITY_MODE_OFF                0
#define SECURITY_MODE_PRECONFIGURED_KEYS 1
#define SECURITY_MODE_COORD_DIST_KEYS    2

//Callbacks
#define CALLBACKS_DISABLED              0
#define CALLBACKS_ENABLED               1

//used in PERMIT_JOINING_REQUEST methods
#define NO_TIMEOUT                      0xFF

//used in setting PAN ID
#define ANY_PAN                         0xFFFF

//
//ZDO States - returned from get Device Information Property(DIP_STATE)
//
#define DEV_HOLD                        0
#define DEV_INIT                        1
#define DEV_NWK_DISC                    2
#define DEV_NWK_JOINING                 3
#define DEV_NWK_REJOIN                  4
#define DEV_END_DEVICE_UNAUTH           5
#define DEV_END_DEVICE                  6
#define DEV_ROUTER                      7
#define DEV_COORD_STARTING              8
#define DEV_ZB_COORD                    9
#define DEV_NWK_ORPHAN                  10

//used in setting CHAN_LIST
//see ZDO_MGMT_NWK_UPDATE_REQ
#define ANY_CHANNEL                     0x07FFF800
#define MIN_CHANNEL                     0x00000800
#define MAX_CHANNEL                     ANY_CHANNEL

//
//      GPIO Pin read/write
//
//Operations:
#define GPIO_SET_DIRECTION      0x00
#define GPIO_SET_INPUT_MODE     0x01
#define GPIO_SET                0x02
#define GPIO_CLEAR              0x03
#define GPIO_TOGGLE             0x04
#define GPIO_READ               0x05

#define ALL_GPIO_PINS           0x0F  //GPIO 0-3

//options for GPIO_SET_INPUT_MODE
#define GPIO_INPUT_MODE_ALL_PULL_DOWNS  0xF0
#define GPIO_INPUT_MODE_ALL_PULL_UPS    0x00
#define GPIO_INPUT_MODE_ALL_TRI_STATE   0x0F
#define GPIO_DIRECTION_ALL_INPUTS       0x00

#define MIN_NV_ITEM                     1
#define MAX_NV_ITEM                     6
//2 Bytes each:
#define NV_ITEM_1                       0x0F01
#define NV_ITEM_2                       0x0F02
#define NV_ITEM_3                       0x0F03
#define NV_ITEM_4                       0x0F04
//16 Bytes each:
#define NV_ITEM_5                       0x0F05
#define NV_ITEM_6                       0x0F06

#endif

---